/*
 * Copyright (c) 2013   Tobias Welther
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package de.tudarmstadt.kom.androidsensorapi.sensor.data.concrete;

import android.hardware.Sensor;
import android.hardware.SensorEvent;

import java.util.Date;

import de.tudarmstadt.kom.androidsensorapi.sensor.data.AbstractSensorData;

/**
 * Created by Tobias Welther
 */
public class AccelerometerSensorData extends AbstractSensorData{

    /**
     * The acceleration in X direction.
     * Values are in m/s².
     */
    private final float accelerationX;

    /**
     * The acceleration in Y direction.
     * Values are in m/s².
     */
    private final float accelerationY;

    /**
     * The acceleration in Z direction.
     * Values are in m/s².
     */
    private final float accelerationZ;


    /**
     * Creates a SensorInterface Data Set with an creation date.
     *
     * @param dateOfCreation the date of creation of the SensorInterface Event
     * @param accelerationX the Acceleration in X direction
     * @param accelerationY the Acceleration in Y direction
     * @param accelerationZ the Acceleration in Z direction
     */
    public AccelerometerSensorData(Date dateOfCreation, float accelerationX,
                                   float accelerationY, float accelerationZ) {

        super(dateOfCreation);

        this.accelerationX = accelerationX;
        this.accelerationY = accelerationY;
        this.accelerationZ = accelerationZ;
    }

    /**
     * Generates Accelerometer Data from a given SensorEvent.
     * It is assumed that the Event is of type: SensorInterface.TYPE_ACCELEROMETER.
     *
     * This can throw an unsupported Operation Exception when the wrong or insufficient Data is passed.
     *
     * @param event to copy from
     *
     * @throws UnsupportedOperationException when wrong event is passed.
     */
    public AccelerometerSensorData(SensorEvent event) {
        super(event);

        if(event.sensor.getType() != Sensor.TYPE_ACCELEROMETER ||
                event.values.length < 3){

            throw new UnsupportedOperationException("The Accelerometer Data can not be read from: "
                    + event.sensor.getName());
        }

        float[] values = event.values;
        this.accelerationX = values[0];
        this.accelerationY = values[1];
        this.accelerationZ = values[2];
    }

    /**
     * Returns the acceleration in X direction.
     * Values are in m/s².
     *
     * @return
     */
    public float getAccelerationX() {
        return accelerationX;
    }


    /**
     * Returns the acceleration in Y direction.
     * Values are in m/s².
     *
     * @return
     */
    public float getAccelerationY() {
        return accelerationY;
    }


    /**
     * Returns the acceleration in Z direction.
     * Values are in m/s².
     *
     * @return
     */
    public float getAccelerationZ() {
        return accelerationZ;
    }
}
